Revision History

Added information about the following calls:

• Restart Supervised iOS Devices

• List Bulk Enrollment Profiles

Added information about the following calls:

• Sync Compliance Status of a Device

• Get the Status of the Asynchronous Request

• Retry Installation of Error Configurations

Added information about the Bulk Enrollment API Calls.

Added information about the call, Get Reports List.

Added information about the call, Get All Accounts.

Removed outdated and unnecessary chapter, "Making Your First API Calls." Ivanti, Inc. assumes that the audience for this guide has advanced API experience.

Added information about the call, Get the List of Applications Available to a Particular Device

Added information about the the iosDisallowProximitySetup, iosPreserveDataPlan, and messages parameters to the documentation for the call, Wipe device.

Added more details to the documentation for the call, Generate User Registration PIN.

• Updated the following calls to include the assignedPoliciesAndConfigs and assignedPolicies parameters, which reduce return size and processing time if set to false:

  • Get List of Device Groups

  • Get General Information about a Device Group

• Added documentation for the call, Get Device Group by Name Across Partitions

• Added notes to the following sections about adding _# to the attribute name when using numerical custom device attributes in calls:

  • Create a Device Group

  • Get Device Details by Device Group

  • Add/Replace Custom Attributes Per Device

  • Patch custom attributes per device

  • Remove custom attributes per device - method 1

  • Remove custom attributes per device - method 2

  • Get Device Details Based on Attribute

Added documentation for the call Get current license information.

Provided a new example request for creating an in-house app in the documentation for the call, Create an App.

Added documentation for the following calls:

• Check Disable Lost Mode Viability (iOS only)

• Disable Lost Mode (iOS only)

• Updated the call Apply a Custom Attribute to a User with additional call information and added an HTTP example.

Fixed formatting that was hiding important text in the HTML output of Searching for devices efficiently.

Added documentation for the following calls:

• Get all custom attributes for an application version

• Assign custom attributes to an application version

• Update custom attributes for an application version

• Delete custom attributes for an application version

• Update custom attributes for applications

• Update custom attributes for an application

• Delete custom attributes for an application

• Delete custom attributes for applications

• Check Disable Lost Mode Viability (iOS only)

• Disable Lost Mode (iOS only)

• Cancel Relinquish device (Android only)

• Added documentation for the following calls:

  • Check force logout viability

  • Force logout current users from devices

• Fixed typographical error in the call, Get Application Configuration.

• Added note that you may only receive 50 rows in the return if the API call is against the database, for example, getting a list of user groups or device groups.

Added information about how to delete multiple users at once to the call, Delete Users

• Added the following calls:

  • Check Update Operating System (OS) Version Viability (iOS Only)

  • Update Operating System (OS) Version (iOS only)

  • Enable Lost Mode (iOS only)

• Added the section, Searching for devices efficiently, which describes how to use the sortFields and the new searchAfterValues parameters to perform efficient device searches in environments with ten-thousand or more devices.

• Updated the following calls to include the searchAfterValues parameter:

  • Get Device Details Based on Attribute

  • Get List of Devices Registered Within x Amount of Time

  • Get List of Devices Checked In Within x Amount of Time

  • List Devices by UID or Email Address

Updated list of GDPR fields.

• Re-branded "Cloud" as "Ivanti Neurons for MDM."

• Added the following calls:

  • Install an App to devices with specified GUIDs - Asynchronous - iOS Only

  • Install an App based on App Distribution Filters - Asynchronous - iOS Only

  • Get asynchronous task list for current user

Fixed issues with the Table of Contents.

Changes include:

• Renamed some calls and updated supporting documentation to be:

  • Exclude a Configuration from a Device

  • Push an excluded configuration to a device

  • Re-install a Configuration to a Device

• Fixed typos.

• Updated copyright statement to reflect Ivanti, Inc, instead of Ivanti.

Added the following calls:

• Get certificates assigned to a device

• Get list of manually revoked certificates for specific date

• Updated Delete Device documentation to indicate that Device should not be in the "ACTIVE" or "WIPE_PENDING" state when you attempt this call.

This guide is rebranded to align with Ivanti standards and is now available on the Ivanti documentation website. Search for "Ivanti Neurons for MDM."

• Added the androidSecurityPatchLevel return field to the Get Device Details call.

• Moved the apps configurations calls, Create Application Configuration and Update Application Configuration to the Apps API Calls chapter.

• Added the call, Update In-House App Icons.

• Added the call, Remove custom attributes per device - method 2. This method leaves in place custom attributes not specified in the call.

• Removed rate limit guidance for the Get Application Inventory for a Particular Device call. There is no rate limit imposed for this call.

• Clarified the description of the forceOverwrite parameter for the Patch custom attributes per device call.

Updated the sections API Limits and Get Application Inventory for a Particular Device, that Ivanti Neurons for MDM now limits this call to thirty calls per minute per user. Previous limit was three calls per minute per user.

Added the following response fields to the returns of selected Device API calls:

• legalOwnerId

• legalOwnerEmailAddress

Added GET custom attributes call.

Updated the section, API Limits.

• Added the Get Connector status call.
• Clarified use of rows parameter throughout guide. Do not send a value larger than 500 with the rows parameter because the APIs do not permit a value of greater than 500.
• Added the managed field to the return of the Get Application Inventory for a Particular Device call.
• Documented the ability to now use the device GUID as the identifier in the Get Device Details call.
• Added the timeZone field to the return of the Get Device Details call.
• Documented the enhanced Patch custom attributes per device call that allows updates of individual custom attributes, and addition of custom attributes.

• Added the installedAt field to the return of the Get Application Inventory for a Particular Device call.
• Added the ipAddress field to the return of the Get List of Devices Checked In Within x Amount of Time call.
• Updated the Get Device Enrollment Program (DEP) details by DEP profile ID call.
• Added the esimIdentifier and bootstrapTokenAvailable fields to the return of the device details call.
• Added the minOsVersion field to the return of the various app details calls in this guide.
• Added the Get MDM profile call used when interacting with a custom Device Enrollment web page.

• Added the passcodeCompliantWithProfiles response field to the following calls:
  • Get Device Details by Device Group
  • Get Device Details
  • Get Device Details Based on Attribute
  • Get List of Devices Checked In Within x Amount of Time
• Updated the Response Fields section of the documentation for the call, Get iTunes App Info by appStoreId, to state that as of Ivanti Neurons for MDM 70, the displayVersion value matches the secondaryVersion value for iOS apps.

Described the new priority parameter and added it to the following calls:

• Create Application Configuration
• Update Application Configuration

Updated the following calls:

• Remove custom attributes per device - method 1: This call removes selected custom attributes, rather than removing all custom attributes.
• Assign a Device to a User: Changed the deviceId parameter to deviceIds.

Added the return fields currentCountryName and homeCountryName to the following calls:

• Get Device Details
• Get List of Devices Checked In Within x Amount of Time

Added the accountIds and accountGroupIds parameters to the call, Install an App based on App Distribution Filters - Synchronous - iOS Only, which allow for custom distribution of the app.

Added the following calls:

• Discover Devices Eligible for a Given App
• Install an App to devices with specified GUIDs - Synchronous - iOS Only
• Install an App based on App Distribution Filters - Synchronous - iOS Only

Added the following calls:

• Get a List of In-House Apps and Associated Provisioning Profile
• Get List of Certificates Requiring Manual Revocation

• Added the availableCapacity and totalCapacity return fields to the call, Get List of Devices Registered Within x Amount of Time

• Included that you can now use GUIDs as identifying parameters for the following calls:

  • Force check in a device or devices

  • Lock a device or devices

  • Get Custom Attributes Per Device

  • Add/Replace Custom Attributes Per Device

  • Patch custom attributes per device

• Added the call, Remove custom attributes per device - method 1

Added the following calls:

• Get Application Configuration

• Create Application Configuration

• Update Application Configuration

Added the following fields to the return of the GET device details calls: GUID, depEnrolled, depEligible.

Minor: removed extra word in the Delete Device call description.

Added the section, Sorting Results.

• Updated the API Limits statement, clarifying usage of the rows and start parameters, and removing reference to the offset parameter, not used in this API.

• Updated Controlling Results to describe the rows and start parameters, and provided supporting examples.

Updated the API Limits statement.

• Added the following calls:
  • Get list of manually revoked certificates for specific date
  • Delete User-Provided Certificates in Bulk Using CSV File
  • Delete User-Provided Certificates in Bulk Using Using Account and Policy
• Added descriptions of the mutable and MDMChannelId fields.

Replaced instances recommending the GET api/v1/tenant call with the GET /api/v1/metadata/tenant call.

Updated details returned by get device details calls.

Added the following calls:

• List User Groups
• Check Delete Viability
• Delete Group

• Added the Get Device Enrollment Program (DEP) details by DEP profile ID call.
• Added the overrideUrl parameter to the Create an App and Update In-House App Details calls.

Updated the Update In-House App Details call. Notably, added the mandatory primaryVersion and platformAppId parameters.

• Changed Update In-House App Screenshots call from PUT to POST.
• Changed Create a Rule Group call to Create a Device Group.

• In Apps API Calls, noted that all Apps API operations will apply to the default space only.
• In the Get a List of In-House Apps call, updated the description of the cmPartitionId parameter.
• For the Get Application Inventory for a Particular Device call, added a note that Ivanti Neurons for MDM limits this call to three per minute per user.

Replaced the term “partition” with “space” in the explanatory sections of the text. The term “partition” remains in the API parameters and returns.

• Clarified the Update an App section by breaking it into two calls:

  • Uploading the new APK file

  • Copying Previous App Version Artifacts

• Added the following calls:

  • Update In-House App Screenshots

  • Update In-House App Details

  • Delete Device

  • Check Delete User Viability

  • Delete User

• Added the Get All Accounts call.
• Updated the lastRegistrationTime date format in the Get List of Devices Registered Within x Amount of Time call to dd:hr:mm:ss from hr:mm:ss.
• Added note that Basic Authentication is not supported with the Review and Rate an App call.
• Clarified the behavior of the Add/Replace Custom Attributes Per Device and Patch Custom Attributes Per Device calls.

Removed whitelisting requirements. No longer necessary.